Description
An image file consists of a file URI and other attributes and elements that control what pages are displayed and how they are used.
Diagram
Overview
 |
imagefiletype
An image file consists of a file URI and other attributes and elements that control what pages are displayed and how they are used.
 |
Name optional xsd:NCName
The Name attribute gives the first page in the image file a name that can be used in the table of contents or the initial page name.
|
|
FileURL required xsd:anyURI
The URI for the image file.
|
|
ValidationHash optional xsd:string
The ValidationHash attribute contains a hash string that is used to validate the contents of the image file. If the ValidationHash attribute is defined and does not match the contents of the image file, an error message will be displayed instead of the pages from the image file.
|
|
AnnotationServerURL optional xsd:anyURI
This annotation server will be used for all images in the image file, unless a page has an image file server specified below this level.
|
|
ExportErrorAction optional Restriction of xsd:string
The ExportErrorAction attribute specifies what happens if an image can't be retrieved during exporting.
|
|
ExportImageFileName optional xsd:string
This filename template will be used to name this file if exported.
|
|
ImageSettingsName optional xsd:NCName
This named entry in the image settings list will be used for all images in the image file, unless a page has an image settings name specified below this level.
|
|
PageSettingsName optional xsd:NCName
This named entry in the page settings list will be used for all images in the image file, unless a page has an page settings name specified below this level.
|
|
PrintSettingsName optional xsd:NCName
This named entry in the print settings list will be used for all images in the image file, unless a page has an print settings name specified below this level.
|
|
PDFFileType optional xsd:boolean
This specifies that the image file is a PDF file. This is reserved for future use and should not be specified even if the file is a PDF file.
|
|
PDFPassword optional xsd:string
This password will be used to open the image file if the image file is a password protected PDF file.
|
 |
Sequence
 |
Choice optional
 |
|
Count required xsd:positiveInteger
The page count is an integer greater than or equal to 1.
|
|
|
|
Range required Restriction of xsd:string
The page range is represented as a set of continuous page ranges, with each continuous page range either increasing or decreasing.
|
|
Name optional xsd:NCName
The Name attribute gives the first page in the range a name that can be used in the table of contents or the initial page name
|
|
AnnotationFileURL optional xsd:anyURI
This annotation file will be used by all images in the page range. This URL must be for a file and not a server!
|
|
AnnotationServerURL optional xsd:anyURI
This annotation server will be used for all images in the page range.
|
|
ImageSettingsName optional xsd:NCName
This named entry in the image settings list will be used for all images in the page range.
|
|
PageSettingsName optional xsd:NCName
This named entry in the page settings list will be used for all images in the page range.
|
|
PrintSettingsName optional xsd:NCName
This named entry in the print settings list will be used for all images in the page range.
|
|
|
|
Name optional xsd:NCName
The Name attribute gives this page a name that can be used in the table of contents or the initial page name.
|
|
PageNumber required xsd:positiveInteger
The page number to use from the image file. If this page is outside the range of pages in the image file, this page will be added as an error page.
|
|
ThumbnailBitmap optional xsd:base64Binary
Reserved.
|
|
AnnotationFileURL optional xsd:anyURI
This annotation file will be used by the image page. This URL must be for a file and not a server!
|
|
AnnotationServerURL optional xsd:anyURI
This annotation server will be used for this page.
|
|
ImageSettingsName optional xsd:NCName
This named entry in the image settings list will be used for this page.
|
|
PageSettingsName optional xsd:NCName
This named entry in the page settings list will be used for this page.
|
|
PrintSettingsName optional xsd:NCName
This named entry in the print settings list will be used for this page.
|
|
|
|
|
Used By
Attributes
| Name | Type | Use | Default | Fixed | Description |
|---|
| Name | xsd:NCName | optional | | | The Name attribute gives the first page in the image file a name that can be used in the table of contents or the initial page name. |
| FileURL | xsd:anyURI | required | | | The URI for the image file. |
| ValidationHash | xsd:string | optional | | | The ValidationHash attribute contains a hash string that is used to validate the contents of the image file. If the ValidationHash attribute is defined and does not match the contents of the image file, an error message will be displayed instead of the pages from the image file. |
| AnnotationServerURL | xsd:anyURI | optional | | | This annotation server will be used for all images in the image file, unless a page has an image file server specified below this level. |
| ExportErrorAction | Restriction of xsd:string | optional | | | The ExportErrorAction attribute specifies what happens if an image can't be retrieved during exporting. |
| ExportImageFileName | xsd:string | optional | | | This filename template will be used to name this file if exported. |
| ImageSettingsName | xsd:NCName | optional | | | This named entry in the image settings list will be used for all images in the image file, unless a page has an image settings name specified below this level. |
| PageSettingsName | xsd:NCName | optional | | | This named entry in the page settings list will be used for all images in the image file, unless a page has an page settings name specified below this level. |
| PrintSettingsName | xsd:NCName | optional | | | This named entry in the print settings list will be used for all images in the image file, unless a page has an print settings name specified below this level. |
| PDFFileType | xsd:boolean | optional | | | This specifies that the image file is a PDF file. This is reserved for future use and should not be specified even if the file is a PDF file. |
| PDFPassword | xsd:string | optional | | | This password will be used to open the image file if the image file is a password protected PDF file. |
Source
<xsd:complexType name="imagefiletype" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:annotation>
<xsd:documentation>An image file consists of a file URI and other attributes and elements that control what pages are displayed and how they are used.</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:annotation>
<xsd:documentation>An image file has pages that are either unspecified, or specified as a count, range, or individually.</xsd:documentation>
</xsd:annotation>
<xsd:choice minOccurs="0">
<xsd:annotation>
<xsd:documentation>There can be one PageCount element, or one or more of either PageRange or Page elements. PageRange and Page elements can not be mixed in one ImageFile element. To mix, use two or more ImageFile elements specifying the same image file URL.</xsd:documentation>
</xsd:annotation>
<xsd:element name="PageCount" type="pagecounttype">
<xsd:annotation>
<xsd:documentation>A PageCount element specifies the number of pages to use from an image file.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="PageRange" type="pagerangetype" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>A PageRange element specified a list of specific pages to use from an image file.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Page" type="pagetype" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>A Page element specified a specific page to use from an image file.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:choice>
</xsd:sequence>
<xsd:attribute name="Name" type="xsd:NCName" use="optional">
<xsd:annotation>
<xsd:documentation>The Name attribute gives the first page in the image file a name that can be used in the table of contents or the initial page name.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="FileURL" type="xsd:anyURI" use="required">
<xsd:annotation>
<xsd:documentation>The URI for the image file.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="ValidationHash" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>The ValidationHash attribute contains a hash string that is used to validate the contents of the image file. If the ValidationHash attribute is defined and does not match the contents of the image file, an error message will be displayed instead of the pages from the image file.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="AnnotationServerURL" type="xsd:anyURI" use="optional">
<xsd:annotation>
<xsd:documentation>This annotation server will be used for all images in the image file, unless a page has an image file server specified below this level.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="ExportErrorAction" use="optional">
<xsd:annotation>
<xsd:documentation>The ExportErrorAction attribute specifies what happens if an image can't be retrieved during exporting.</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:annotation>
<xsd:documentation>The attribute value is set to one of the following action names.</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:annotation>
<xsd:documentation>The attribute value must be one of these names.</xsd:documentation>
</xsd:annotation>
<xsd:enumeration value="Ignore">
<xsd:annotation>
<xsd:documentation>This value causes exporting to ignore any errors retrieving this file and simply leave it out of the exported image.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="Cancel">
<xsd:annotation>
<xsd:documentation>This value causes exporting to immediately cancel if there are any errors retrieving this file.</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="ExportImageFileName" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>This filename template will be used to name this file if exported.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="ImageSettingsName" type="xsd:NCName" use="optional">
<xsd:annotation>
<xsd:documentation>This named entry in the image settings list will be used for all images in the image file, unless a page has an image settings name specified below this level.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="PageSettingsName" type="xsd:NCName" use="optional">
<xsd:annotation>
<xsd:documentation>This named entry in the page settings list will be used for all images in the image file, unless a page has an page settings name specified below this level.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="PrintSettingsName" type="xsd:NCName" use="optional">
<xsd:annotation>
<xsd:documentation>This named entry in the print settings list will be used for all images in the image file, unless a page has an print settings name specified below this level.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="PDFFileType" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>This specifies that the image file is a PDF file. This is reserved for future use and should not be specified even if the file is a PDF file.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="PDFPassword" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>This password will be used to open the image file if the image file is a password protected PDF file.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType> |
See Also
